<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Docs For Class Auditor</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Interface Auditor
</h2> (line <span class="linenumber">44</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
	<b><i>Located in File: <a href="_Auditor.php.html">/Auditor.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>Use this ESAPI security control to wrap your auditing functions.</h5>
<div class="desc"><p>The idea behind this interface is to define a set of functions that can  be used to log security events. Implementors should use a well  established logging library.</p></div>
<ul>
		<li><strong>author:</strong> - Mike Boberski &lt;<a href="mailto:boberski_michael@bah.com">boberski_michael@bah.com</a>&gt;</li>
		<li><strong>author:</strong> - Laura Bell &lt;<a href="mailto:laura.d.bell@gmail.com">laura.d.bell@gmail.com</a>&gt;</li>
		<li><strong>author:</strong> - Andrew van der Stock &lt;<a href="mailto:vanderaj@owasp.org">vanderaj@owasp.org</a>&gt;</li>
		<li><strong>author:</strong> - jah &lt;<a href="mailto:jah@jahboite.co.uk">jah@jahboite.co.uk</a>&gt;</li>
		<li><strong>version:</strong> - Release: @package_version@</li>
		<li><strong>copyright:</strong> - 2009-2010 The OWASP Foundation</li>
		<li><strong>link:</strong> - <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a></li>
		<li><strong>license:</strong> - <a href="http://www.opensource.org/licenses/bsd-license.php">New BSD license</a></li>
	</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="const-title">
    <a href="#constALL" title="details" class="property"><strong>ALL</strong></a>
</div>
<div class="const-title">
    <a href="#constDEBUG" title="details" class="property"><strong>DEBUG</strong></a>
</div>
<div class="const-title">
    <a href="#constERROR" title="details" class="property"><strong>ERROR</strong></a>
</div>
<div class="const-title">
    <a href="#constFATAL" title="details" class="property"><strong>FATAL</strong></a>
</div>
<div class="const-title">
    <a href="#constFUNCTIONALITY" title="details" class="property"><strong>FUNCTIONALITY</strong></a>
</div>
<div class="const-title">
    <a href="#constINFO" title="details" class="property"><strong>INFO</strong></a>
</div>
<div class="const-title">
    <a href="#constOFF" title="details" class="property"><strong>OFF</strong></a>
</div>
<div class="const-title">
    <a href="#constPERFORMANCE" title="details" class="property"><strong>PERFORMANCE</strong></a>
</div>
<div class="const-title">
    <a href="#constSECURITY" title="details" class="property"><strong>SECURITY</strong></a>
</div>
<div class="const-title">
    <a href="#constTRACE" title="details" class="property"><strong>TRACE</strong></a>
</div>
<div class="const-title">
    <a href="#constUSABILITY" title="details" class="property"><strong>USABILITY</strong></a>
</div>
<div class="const-title">
    <a href="#constWARNING" title="details" class="property"><strong>WARNING</strong></a>
</div>
<hr />
<a name="constALL" id="constALL"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">ALL =  0</strong> (line <span class="linenumber">129</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>ALL indicates that all messages should be logged.</h5>
<div class="desc"><p>This level is initialized to 0.</p></div>
<ul>
	</ul>
</div>
<a name="constDEBUG" id="constDEBUG"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">DEBUG =  200</strong> (line <span class="linenumber">117</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>DEBUG indicates that DEBUG messages and above should be logged.</h5>
<div class="desc"><p>This level is initialized to 200.</p></div>
<ul>
	</ul>
</div>
<a name="constERROR" id="constERROR"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">ERROR =  800</strong> (line <span class="linenumber">99</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>ERROR indicates that ERROR messages and above should be logged.</h5>
<div class="desc"><p>This level is initialized to 800.</p></div>
<ul>
	</ul>
</div>
<a name="constFATAL" id="constFATAL"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">FATAL =  1000</strong> (line <span class="linenumber">93</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>FATAL indicates that only FATAL messages should be logged.</h5>
<div class="desc"><p>This level is initialized to 1000.</p></div>
<ul>
	</ul>
</div>
<a name="constFUNCTIONALITY" id="constFUNCTIONALITY"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">FUNCTIONALITY =  'FUNCTIONALITY'</strong> (line <span class="linenumber">74</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>The FUNCTIONALITY type of log event. This is the type of event that  non-security focused loggers typically log. If you are going to log your  existing non-security events in the same log with your security events,  you probably want to use this type of log event.</h5>
<ul>
	</ul>
</div>
<a name="constINFO" id="constINFO"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">INFO =  400</strong> (line <span class="linenumber">111</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>INFO indicates that INFO messages and above should be logged.</h5>
<div class="desc"><p>This level is initialized to 400.</p></div>
<ul>
	</ul>
</div>
<a name="constOFF" id="constOFF"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">OFF =  PHP_INT_MAX</strong> (line <span class="linenumber">87</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>OFF indicates that no messages should be logged.</h5>
<div class="desc"><p>This level is initialized to PHP_INT_MAX.</p></div>
<ul>
	</ul>
</div>
<a name="constPERFORMANCE" id="constPERFORMANCE"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">PERFORMANCE =  'PERFORMANCE'</strong> (line <span class="linenumber">66</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>The PERFORMANCE type of log event.</h5>
<ul>
	</ul>
</div>
<a name="constSECURITY" id="constSECURITY"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">SECURITY =  'SECURITY'</strong> (line <span class="linenumber">56</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>The SECURITY type of log event.</h5>
<ul>
	</ul>
</div>
<a name="constTRACE" id="constTRACE"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">TRACE =  100</strong> (line <span class="linenumber">123</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>TRACE indicates that TRACE messages and above should be logged.</h5>
<div class="desc"><p>This level is initialized to 100.</p></div>
<ul>
	</ul>
</div>
<a name="constUSABILITY" id="constUSABILITY"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">USABILITY =  'USABILITY'</strong> (line <span class="linenumber">61</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>The USABILITY type of log event.</h5>
<ul>
	</ul>
</div>
<a name="constWARNING" id="constWARNING"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">WARNING =  600</strong> (line <span class="linenumber">105</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>WARNING indicates that WARNING messages and above should be logged.</h5>
<div class="desc"><p>This level is initialized to 600.</p></div>
<ul>
	</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
    <div class="method-definition">
            <span class="method-result">does</span>
        <a href="#methoddebug" title="details" class="method-name">debug</a>
        (<span class="var-type">int</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$success</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">does</span>
        <a href="#methoderror" title="details" class="method-name">error</a>
        (<span class="var-type">int</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$success</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">does</span>
        <a href="#methodfatal" title="details" class="method-name">fatal</a>
        (<span class="var-type">int</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$success</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">does</span>
        <a href="#methodinfo" title="details" class="method-name">info</a>
        (<span class="var-type">int</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$success</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodisDebugEnabled" title="details" class="method-name">isDebugEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodisErrorEnabled" title="details" class="method-name">isErrorEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodisFatalEnabled" title="details" class="method-name">isFatalEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodisInfoEnabled" title="details" class="method-name">isInfoEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodisTraceEnabled" title="details" class="method-name">isTraceEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">bool</span>
        <a href="#methodisWarningEnabled" title="details" class="method-name">isWarningEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">does</span>
        <a href="#methodsetLevel" title="details" class="method-name">setLevel</a>
        (<span class="var-type">int</span>&nbsp;<span class="var-name">$level</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">does</span>
        <a href="#methodtrace" title="details" class="method-name">trace</a>
        (<span class="var-type">int</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$success</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">does</span>
        <a href="#methodwarning" title="details" class="method-name">warning</a>
        (<span class="var-type">int</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$success</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="methoddebug" id="methoddebug"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method debug</strong> (line <span class="linenumber">257</span>)
 </h4> 
<h4><i>does</i> <strong>debug(
int
$type, bool
$success, string
$message, [string
$throwable = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Log a debug level security event if 'debug' level logging is enabled and  also record the stack trace associated with the event.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>int $type</strong>: the type of event - an Logger Type constant.</li>
			<li><strong>bool $success</strong>: boolean true indicates this was a successful event,                           false indicates this was a failed event (the                           typical value).</li>
			<li><strong>string $message</strong>: the message to log.</li>
			<li><strong>string $throwable</strong>: the exception to be logged.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value</li>
		</ul>
</div>
<a name="methoderror" id="methoderror"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method error</strong> (line <span class="linenumber">182</span>)
 </h4> 
<h4><i>does</i> <strong>error(
int
$type, bool
$success, string
$message, [string
$throwable = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Log an error level security event if 'error' level logging is enabled and  also record the stack trace associated with the event.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>int $type</strong>: the type of event - an Logger Type constant.</li>
			<li><strong>bool $success</strong>: boolean true indicates this was a successful event,                           false indicates this was a failed event (the typical                           value).</li>
			<li><strong>string $message</strong>: the message to log.</li>
			<li><strong>string $throwable</strong>: the exception to be logged.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value.</li>
		</ul>
</div>
<a name="methodfatal" id="methodfatal"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method fatal</strong> (line <span class="linenumber">157</span>)
 </h4> 
<h4><i>does</i> <strong>fatal(
int
$type, bool
$success, string
$message, [string
$throwable = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Log a fatal level security event if 'fatal' level logging is enabled and  also record the stack trace associated with the event.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>int $type</strong>: the type of event - an Logger Type constant.</li>
			<li><strong>bool $success</strong>: boolean true indicates this was a successful event,                           false indicates this was a failed event (the typical                           value).</li>
			<li><strong>string $message</strong>: the message to log.</li>
			<li><strong>string $throwable</strong>: the exception to be logged.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value.</li>
		</ul>
</div>
<a name="methodinfo" id="methodinfo"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method info</strong> (line <span class="linenumber">232</span>)
 </h4> 
<h4><i>does</i> <strong>info(
int
$type, bool
$success, string
$message, [string
$throwable = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Log an info level security event if 'info' level logging is enabled and  also record the stack trace associated with the event.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>int $type</strong>: the type of event - an Logger Type constant.</li>
			<li><strong>bool $success</strong>: boolean true indicates this was a successful event,                           false indicates this was a failed event (the                           typical value).</li>
			<li><strong>string $message</strong>: the message to log.</li>
			<li><strong>string $throwable</strong>: the exception to be logged.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value</li>
		</ul>
</div>
<a name="methodisDebugEnabled" id="methodisDebugEnabled"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isDebugEnabled</strong> (line <span class="linenumber">266</span>)
 </h4> 
<h4><i>bool</i> <strong>isDebugEnabled(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - true if debug level messages will be output to the log.</li>
		</ul>
</div>
<a name="methodisErrorEnabled" id="methodisErrorEnabled"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isErrorEnabled</strong> (line <span class="linenumber">191</span>)
 </h4> 
<h4><i>bool</i> <strong>isErrorEnabled(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - true if error level messages will be output to the log.</li>
		</ul>
</div>
<a name="methodisFatalEnabled" id="methodisFatalEnabled"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isFatalEnabled</strong> (line <span class="linenumber">166</span>)
 </h4> 
<h4><i>bool</i> <strong>isFatalEnabled(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - true if fatal level messages will be output to the log.</li>
		</ul>
</div>
<a name="methodisInfoEnabled" id="methodisInfoEnabled"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isInfoEnabled</strong> (line <span class="linenumber">241</span>)
 </h4> 
<h4><i>bool</i> <strong>isInfoEnabled(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - true if info level messages will be output to the log.</li>
		</ul>
</div>
<a name="methodisTraceEnabled" id="methodisTraceEnabled"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isTraceEnabled</strong> (line <span class="linenumber">291</span>)
 </h4> 
<h4><i>bool</i> <strong>isTraceEnabled(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - true if trace level messages will be output to the log.</li>
		</ul>
</div>
<a name="methodisWarningEnabled" id="methodisWarningEnabled"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isWarningEnabled</strong> (line <span class="linenumber">216</span>)
 </h4> 
<h4><i>bool</i> <strong>isWarningEnabled(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - true if warning level messages will be output to the log.</li>
		</ul>
</div>
<a name="methodsetLevel" id="methodsetLevel"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setLevel</strong> (line <span class="linenumber">141</span>)
 </h4> 
<h4><i>does</i> <strong>setLevel(
int
$level)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Dynamically set the logging severity level. All events of this level and  higher will be logged from this point forward for all logs. All events  below this level will be discarded.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>int $level</strong>: The level to set the logging level to.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value.</li>
		</ul>
</div>
<a name="methodtrace" id="methodtrace"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method trace</strong> (line <span class="linenumber">282</span>)
 </h4> 
<h4><i>does</i> <strong>trace(
int
$type, bool
$success, string
$message, [string
$throwable = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Log a trace level security event if 'trace' level logging is enabled and  also record the stack trace associated with the event.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>int $type</strong>: the type of event - an Logger Type constant.</li>
			<li><strong>bool $success</strong>: boolean true indicates this was a successful event,                           false indicates this was a failed event (the typical                           value).</li>
			<li><strong>string $message</strong>: the message to log.</li>
			<li><strong>string $throwable</strong>: the exception to be logged.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value.</li>
		</ul>
</div>
<a name="methodwarning" id="methodwarning"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method warning</strong> (line <span class="linenumber">207</span>)
 </h4> 
<h4><i>does</i> <strong>warning(
int
$type, bool
$success, string
$message, [string
$throwable = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Log a warning level security event if 'warning' level logging is enabled and  also record the stack trace associated with the event.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>int $type</strong>: the type of event - an Logger Type constant.</li>
			<li><strong>bool $success</strong>: boolean true indicates this was a successful event,                           false indicates this was a failed event (the typical                           value).</li>
			<li><strong>string $message</strong>: the message to log.</li>
			<li><strong>string $throwable</strong>: the exception to be logged.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value.</li>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

	</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Fri, 21 May 2010 14:53:27 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</div>
</body>
</html>